<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Secure Sockets: Typedefs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="cypress_logo.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Secure Sockets</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group__group__cy__tls__typedefs.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#typedef-members">Typedefs</a>  </div>
  <div class="headertitle"><div class="title">Typedefs<div class="ingroups"><a class="el" href="group__group__cy__tls.html">TLS API</a></div></div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga0d99157c08499d8a8162a01bc60120fa"><td class="memItemLeft" align="right" valign="top"><a id="ga0d99157c08499d8a8162a01bc60120fa" name="ga0d99157c08499d8a8162a01bc60120fa"></a>
typedef void *&#160;</td><td class="memItemRight" valign="bottom"><b>cy_tls_context_t</b></td></tr>
<tr class="memdesc:ga0d99157c08499d8a8162a01bc60120fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">TLS context type. <br /></td></tr>
<tr class="separator:ga0d99157c08499d8a8162a01bc60120fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4deb60051b4e0097cef5e7be77ade9f0"><td class="memItemLeft" align="right" valign="top">typedef cy_rslt_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__cy__tls__typedefs.html#ga4deb60051b4e0097cef5e7be77ade9f0">cy_network_send_t</a>) (void *context, const unsigned char *buffer, uint32_t length, uint32_t *bytes_sent)</td></tr>
<tr class="memdesc:ga4deb60051b4e0097cef5e7be77ade9f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function used by the underlying TLS stack for sending the TLS handshake messages and encrypted data over the network.  <a href="group__group__cy__tls__typedefs.html#ga4deb60051b4e0097cef5e7be77ade9f0">More...</a><br /></td></tr>
<tr class="separator:ga4deb60051b4e0097cef5e7be77ade9f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga10fc7493040524d0e1f0f8c12435304c"><td class="memItemLeft" align="right" valign="top">typedef cy_rslt_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__cy__tls__typedefs.html#ga10fc7493040524d0e1f0f8c12435304c">cy_network_recv_t</a>) (void *context, unsigned char *buffer, uint32_t length, uint32_t *bytes_received)</td></tr>
<tr class="memdesc:ga10fc7493040524d0e1f0f8c12435304c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function used by the underlying TLS stack for reading TLS handshake messages or the encrypted data from the network.  <a href="group__group__cy__tls__typedefs.html#ga10fc7493040524d0e1f0f8c12435304c">More...</a><br /></td></tr>
<tr class="separator:ga10fc7493040524d0e1f0f8c12435304c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga4deb60051b4e0097cef5e7be77ade9f0" name="ga4deb60051b4e0097cef5e7be77ade9f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4deb60051b4e0097cef5e7be77ade9f0">&#9670;&nbsp;</a></span>cy_network_send_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef cy_rslt_t(* cy_network_send_t) (void *context, const unsigned char *buffer, uint32_t length, uint32_t *bytes_sent)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback function used by the underlying TLS stack for sending the TLS handshake messages and encrypted data over the network. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>User context provided at the time of callback registration. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Buffer of the data to send. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>Length of the buffer. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">bytes_sent</td><td>Number of bytes successfully sent over the network.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS on success; an error code on failure. On success, it also returns the number of bytes sent. </dd></dl>

</div>
</div>
<a id="ga10fc7493040524d0e1f0f8c12435304c" name="ga10fc7493040524d0e1f0f8c12435304c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga10fc7493040524d0e1f0f8c12435304c">&#9670;&nbsp;</a></span>cy_network_recv_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef cy_rslt_t(* cy_network_recv_t) (void *context, unsigned char *buffer, uint32_t length, uint32_t *bytes_received)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback function used by the underlying TLS stack for reading TLS handshake messages or the encrypted data from the network. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>User context provided at the time of callback registration. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">buffer</td><td>Buffer into which the received data will be placed. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>Size of the buffer. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">bytes_received</td><td>Number of bytes received.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS on success; an error code on failure. On success, it also returns the number of bytes received. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>Secure Sockets</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
</body>
</html>
